Skip to content

feat: log the number of read/written bytes on IMAP stream read error #6924

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat: log the number of read/written bytes on IMAP stream read error #6924

wants to merge 2 commits into from

Conversation

link2xt
Copy link
Collaborator

@link2xt link2xt commented Jun 18, 2025 •
edited
Loading

LoggingStream is a wrapper for IMAP/SMTP/HTTP session streams. Originally I started building it with the idea to debug #6477 and similar issues where IMAP loop gets stuck with the hope that right before the loop gets stuck or even continuously there are socket errors like a read timeout that are not treated correctly.

This can later be expanded to collect the metrics in the database, display them in the connectivity view, but not in this PR. Same for logging the write or flush errors, I have not added it for now because they are less common.

@link2xt link2xt force-pushed the link2xt/logging-stream branch from 2893f40 to 8efff30 Compare June 26, 2025 18:53
@link2xt link2xt force-pushed the link2xt/logging-stream branch 3 times, most recently from 7ce86bd to f6df3ee Compare July 13, 2025 06:51
@link2xt
Copy link
Collaborator Author

link2xt commented Jul 13, 2025

First commit currently adds peer_addr method to SessionStream trait. I also created chatmail/async-imap#120 that may be useful to get access to SessionStream of IMAP session and then to peer_addr, e.g. to log it or add current address to connectivity view.

@link2xt link2xt force-pushed the link2xt/logging-stream branch 2 times, most recently from 01d9db2 to 5ca9bb1 Compare July 13, 2025 10:15
@link2xt
Copy link
Collaborator Author

link2xt commented Jul 13, 2025

Logs look like this:

Read error on stream a.b.c.d:993 after reading 98624 and writing 1074 bytes: timed out.
src/scheduler.rs:422: Failed inbox fetch_idle: fetch_move_delete: fetch_new_messages: fetch_many_msgs: Failed to process IMAP FETCH result: io: timed out: timed out.

Now right before the message about IMAP timeout we get a log message with the peer address and the number of read and written bytes.

@link2xt link2xt changed the title feat: add logging to streams feat: log the number of read/written bytes on IMAP stream read error Jul 13, 2025
@link2xt link2xt force-pushed the link2xt/logging-stream branch from 5ca9bb1 to 932a8e1 Compare July 13, 2025 10:45
@link2xt link2xt marked this pull request as ready for review July 13, 2025 11:08
@link2xt link2xt force-pushed the link2xt/logging-stream branch from 932a8e1 to ff537b8 Compare July 13, 2025 16:34
@link2xt link2xt requested review from Hocuri and iequidoo July 16, 2025 02:46
@link2xt link2xt mentioned this pull request Jul 16, 2025
Open
Hocuri
Hocuri reviewed Jul 16, 2025
View reviewed changes
Copy link
Collaborator

@Hocuri Hocuri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I read through the code and found 3 minor things, otherwise looks good. But I don't know this code, so, I can's say for sure that I didn't overlook anything - please be sure to double-check yourself, because this is an area where it would be bad to have a bug.

src/log/logging_stream.rs Outdated
Comment on lines 80 to 81
if let Ok(peer_addr) = peer_addr {
let log_message = format!(
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it on purpose that nothing is logged if the peer_addr is Err?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be impossible, I think to have unbound socket you need to convert it from raw FD. But I'll add a warning in this case and debug_assert.

@link2xt link2xt force-pushed the link2xt/logging-stream branch from ff537b8 to 7f0841b Compare July 16, 2025 13:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Hocuri Hocuri Hocuri left review comments

@iequidoo iequidoo Awaiting requested review from iequidoo

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@link2xt @Hocuri